# This file contains a definition of the scalar probes that are recorded in Telemetry.
# They are submitted with the "main" pings and can be inspected in about:telemetry.

# The following section contains the aushelper system add-on scalars.
aushelper:
  websense_reg_version:
    bug_numbers:
      - 1305847
    description: The Websense version from the Windows registry.
    expires: "60"
    kind: string
    notification_emails:
      - application-update-telemetry-alerts@mozilla.com
    release_channel_collection: opt-out

# The following section contains the browser engagement scalars.
browser.engagement:
  max_concurrent_tab_count:
    bug_numbers:
      - 1271304
    description: >
      The count of maximum number of tabs open during a subsession,
      across all windows, including tabs in private windows and restored
      at startup.
    expires: "55"
    kind: uint
    notification_emails:
      - rweiss@mozilla.com
    release_channel_collection: opt-out

  tab_open_event_count:
    bug_numbers:
      - 1271304
    description: >
      The count of tab open events per subsession, across all windows, after the
      session has been restored. This includes tab open events from private windows
      and from manual session restorations (i.e. after crashes and from about:home).
    expires: "55"
    kind: uint
    notification_emails:
      - rweiss@mozilla.com
    release_channel_collection: opt-out

  max_concurrent_window_count:
    bug_numbers:
      - 1271304
    description: >
      The count of maximum number of browser windows open during a subsession. This
      includes private windows and the ones opened when starting the browser.
    expires: "55"
    kind: uint
    notification_emails:
      - rweiss@mozilla.com
    release_channel_collection: opt-out

  window_open_event_count:
    bug_numbers:
      - 1271304
    description: >
      The count of browser window open events per subsession, after the session
      has been restored. The count includes private windows and the ones from manual
      session restorations (i.e. after crashes and from about:home).
    expires: "55"
    kind: uint
    notification_emails:
      - rweiss@mozilla.com
    release_channel_collection: opt-out

  total_uri_count:
    bug_numbers:
      - 1271313
    description: >
      The count of the total non-unique http(s) URIs visited in a subsession, including
      page reloads, after the session has been restored. This does not include background
      page requests and URIs from embedded pages or private browsing.
    expires: "55"
    kind: uint
    notification_emails:
      - rweiss@mozilla.com
    release_channel_collection: opt-out

  unfiltered_uri_count:
    bug_numbers:
      - 1304647
    description: >
      The count of the total non-unique URIs visited in a subsession, not restricted to
      a specific protocol, including page reloads and about:* pages (other than initial
      pages such as about:blank, ...), after the session has been restored. This does
      not include background page requests and URIs from embedded pages or private browsing.
    expires: "55"
    kind: uint
    notification_emails:
      - bcolloran@mozilla.com
    release_channel_collection: opt-out

  unique_domains_count:
    bug_numbers:
      - 1271310
    description: >
      The count of the unique domains visited in a subsession, after the session
      has been restored. Subdomains under eTLD are aggregated after the first level
      (i.e. test.example.com and other.example.com are only counted once).
      This does not include background page requests and domains from embedded pages
      or private browsing. The count is limited to 100 unique domains.
    expires: "55"
    kind: uint
    notification_emails:
      - rweiss@mozilla.com
    release_channel_collection: opt-out

# The following section contains the browser engagement scalars.
browser.engagement.navigation:
  urlbar:
    bug_numbers:
      - 1271313
    description: >
      The count URI loads triggered in a subsession from the urlbar (awesomebar),
      broken down by the originating action.
    expires: "55"
    kind: uint
    keyed: true
    notification_emails:
      - bcolloran@mozilla.com
    release_channel_collection: opt-out

  searchbar:
    bug_numbers:
      - 1271313
    description: >
      The count URI loads triggered in a subsession from the searchbar,
      broken down by the originating action.
    expires: "55"
    kind: uint
    keyed: true
    notification_emails:
      - bcolloran@mozilla.com
    release_channel_collection: opt-out

  about_home:
    bug_numbers:
      - 1271313
    description: >
      The count URI loads triggered in a subsession from about:home,
      broken down by the originating action.
    expires: "55"
    kind: uint
    keyed: true
    notification_emails:
      - bcolloran@mozilla.com
    release_channel_collection: opt-out

  about_newtab:
    bug_numbers:
      - 1271313
    description: >
      The count URI loads triggered in a subsession from about:newtab,
      broken down by the originating action.
    expires: "55"
    kind: uint
    keyed: true
    notification_emails:
      - bcolloran@mozilla.com
    release_channel_collection: opt-out

  contextmenu:
    bug_numbers:
      - 1271313
    description: >
      The count URI loads triggered in a subsession from the contextmenu,
      broken down by the originating action.
    expires: "55"
    kind: uint
    keyed: true
    notification_emails:
      - bcolloran@mozilla.com
    release_channel_collection: opt-out

# The following section is for probes testing the Telemetry system. They will not be
# submitted in pings and are only used for testing.
telemetry.test:
  unsigned_int_kind:
    bug_numbers:
      - 1276190
    description: >
      This is a test uint type with a really long description, maybe spanning even multiple
      lines, to just prove a point: everything works just fine.
    expires: never
    kind: uint
    notification_emails:
      - telemetry-client-dev@mozilla.com

  string_kind:
    bug_numbers:
      - 1276190
    description: A string test type with a one line comment that works just fine!
    expires: never
    kind: string
    notification_emails:
      - telemetry-client-dev@mozilla.com

  boolean_kind:
    bug_numbers:
      - 1281214
    description: A boolean test type with a one line comment that works just fine!
    expires: never
    kind: boolean
    notification_emails:
      - telemetry-client-dev@mozilla.com

  expired:
    bug_numbers:
      - 1276190
    description: This is an expired testing scalar; not meant to be touched.
    expires: 4.0a1
    kind: uint
    notification_emails:
      - telemetry-client-dev@mozilla.com

  unexpired:
    bug_numbers:
      - 1276190
    description: This is an unexpired testing scalar; not meant to be touched.
    expires: "375.0"
    kind: uint
    notification_emails:
      - telemetry-client-dev@mozilla.com

  release_optin:
    bug_numbers:
      - 1276190
    description: A testing scalar; not meant to be touched.
    expires: never
    kind: uint
    notification_emails:
      - telemetry-client-dev@mozilla.com
    release_channel_collection: opt-in

  release_optout:
    bug_numbers:
      - 1276190
    description: A testing scalar; not meant to be touched.
    expires: never
    kind: uint
    notification_emails:
      - telemetry-client-dev@mozilla.com
    release_channel_collection: opt-out

  keyed_release_optin:
    bug_numbers:
      - 1277806
    description: A testing scalar; not meant to be touched.
    expires: never
    kind: uint
    keyed: true
    notification_emails:
      - telemetry-client-dev@mozilla.com
    release_channel_collection: opt-in

  keyed_release_optout:
    bug_numbers:
      - 1277806
    description: A testing scalar; not meant to be touched.
    expires: never
    kind: uint
    keyed: true
    notification_emails:
      - telemetry-client-dev@mozilla.com
    release_channel_collection: opt-out

  keyed_expired:
    bug_numbers:
      - 1277806
    description: This is an expired testing scalar; not meant to be touched.
    expires: 4.0a1
    kind: uint
    keyed: true
    notification_emails:
      - telemetry-client-dev@mozilla.com

  keyed_unsigned_int:
    bug_numbers:
      - 1277806
    description: A testing keyed uint scalar; not meant to be touched.
    expires: never
    kind: uint
    keyed: true
    notification_emails:
      - telemetry-client-dev@mozilla.com

  keyed_boolean_kind:
    bug_numbers:
      - 1277806
    description: A testing keyed boolean scalar; not meant to be touched.
    expires: never
    kind: boolean
    keyed: true
    notification_emails:
      - telemetry-client-dev@mozilla.com
